Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-36808: Add citation information #751

Merged
merged 7 commits into from
Jul 1, 2024
Merged

DM-36808: Add citation information #751

merged 7 commits into from
Jul 1, 2024

Conversation

timj
Copy link
Member

@timj timj commented Nov 8, 2022

Checklist

  • ran Jenkins
  • added a release note for user-visible changes to doc/changes

@@ -0,0 +1,71 @@
cff-version: 1.2.0
message: "Please cite the following when using this software: https://doi.org/10.1117/12.2629569"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the commonly accepted paradigm is to say something like "If you use this software, please cite it using this metadata." so that you don't have to update the link twice (here in the message and later in the preferred-citation).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, although I was worried that might lead to an attempt to cite the software itself which doesn't have a DOI or ASCL ID and so thought I should be explicit.

@codecov
Copy link

codecov bot commented Nov 8, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.39%. Comparing base (ada4740) to head (12cf832).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #751   +/-   ##
=======================================
  Coverage   89.39%   89.39%           
=======================================
  Files         358      358           
  Lines       45476    45476           
  Branches     9347     9347           
=======================================
  Hits        40651    40651           
  Misses       3523     3523           
  Partials     1302     1302           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

CITATION.cff Show resolved Hide resolved
@timj
Copy link
Member Author

timj commented Nov 8, 2022

For the first attempt GitHub seems to generate a bibtex entry of:

@article{Jenness_The_Vera_C,
author = {Jenness, Tim and Bosch, James F. and Salnikov, Andrei and Lust, Nate B. and Pease, Nathan M. and Gower, Michelle and Kowalik, Mikolaj and Dubois-Felsmann, Gregory P. and Mueller, Fritz and Schellart, Pim},
title = {{The Vera C. Rubin Observatory Data Butler and pipeline execution system}}
}

which unfortunately lacks the DOI information so I must have got that wrong somewhere.

@timj timj force-pushed the tickets/DM-36808 branch 2 times, most recently from f9daac0 to 3817518 Compare December 6, 2022 23:17
@timj timj force-pushed the tickets/DM-36808 branch 2 times, most recently from d2e1f3c to 18f1ce7 Compare June 27, 2023 23:06
@timj timj force-pushed the tickets/DM-36808 branch 2 times, most recently from 72044da to 1764d3a Compare July 24, 2023 22:47
@timj timj force-pushed the tickets/DM-36808 branch 2 times, most recently from 3e4b1f4 to 6af46ff Compare October 4, 2023 18:00
@timj timj force-pushed the tickets/DM-36808 branch 2 times, most recently from eba08a8 to 30ed34b Compare November 16, 2023 18:09
@timj timj merged commit cfc9be9 into main Jul 1, 2024
18 checks passed
@timj timj deleted the tickets/DM-36808 branch July 1, 2024 22:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants